<!DOCTYPE html>
<html lang="en">

<head>

    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="description" content="">
    <meta name="author" content="">


    <link rel="stylesheet" type="text/css" href="assets/css/bootstrap.min.css">
    <link rel="stylesheet" type="text/css" href="assets/css/bootstrap-theme.min.css">
    <link rel="stylesheet" type="text/css" href="assets/css/github.css">
    <link rel="stylesheet" type="text/css" href="assets/css/style.css">
    <script src="assets/js/jquery-2.2.0.min.js" type="text/javascript"></script>
    <script src="assets/js/bootstrap.min.js" type="text/javascript"></script>
    <script src="assets/js/highlight.pack.js" type="text/javascript"></script>
    <script src="assets/js/main.js" type="text/javascript"></script>
    <script src="assets/js/marked.min.js" type="text/javascript"></script>

    <title>WSO2 API Manager - Gateway : vv1</title>


    <!-- Custom CSS -->
    <link href="css/simple-sidebar.css" rel="stylesheet">

    <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
    <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
    <![endif]-->

</head>

<body>
<nav class="navbar navbar-fixed-top">
    <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"
                aria-expanded="false" aria-controls="navbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="https://docs.wso2.com/api-manager">
            <img src="assets/images/logo.png" alt="WSO2 Api manager" title="WSO2 Api Manager Documentation">
        </a>
    </div>
    <div id="navbar" class="collapse navbar-collapse pull-right">
        <ul class="nav navbar-nav">
            <li>
                <a href="#menu-toggle" id="menu-toggle" class="button-primary"><span
                        class="glyphicon glyphicon-list"></span> Navigation</a>
            </li>
        </ul>
    </div><!--/.nav-collapse -->
</nav>
<div id="wrapper">
    <!-- Sidebar -->
    <div id="sidebar-wrapper">
        <nav class="bs-docs-sidebar" id="navbar">
            <h3>Overview</h3>
            <ul class="nav nav-stacked fixed">
                <li class="section-box">
                    <ul class="nav nav-stacked">
                        <li id="ov-index"><a href="index.html">Introduction</a></li>
                        <li id="ov-guide"><a href="#guide">Getting Started</a></li>
                        <li id="ov-configuring-rest-api"><a href="#configuring-rest-api">Configuring the REST API</a></li>
                    </ul>
                </li>
            </ul>
            <h3>Resources</h3>
            <ul class="nav nav-stacked fixed">
                        <hr/>
                        <span class="class-name">Deploy API</span>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                        <li id="op-redeployApiPost"><a href="#!/operations#DeployAPI#redeployApiPost">Re Deploy the API in the gateway</a></li>
                            </ul>
                        </li>
                        <hr/>
                        <span class="class-name">Get API Artifacts</span>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                        <li id="op-apiArtifactGet"><a href="#!/operations#GetAPIArtifacts#apiArtifactGet">Get API artifact from the storage</a></li>
                                        <li id="op-endPointsGet"><a href="#!/operations#GetAPIArtifacts#endPointsGet">Get end-points from the storage for the API</a></li>
                                        <li id="op-localEntryGet"><a href="#!/operations#GetAPIArtifacts#localEntryGet">Get Local Entry from the storage</a></li>
                                        <li id="op-sequenceGet"><a href="#!/operations#GetAPIArtifacts#sequenceGet">Get sequences from the storage</a></li>
                            </ul>
                        </li>
                        <hr/>
                        <span class="class-name">Undeploy API</span>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                        <li id="op-undeployApiPost"><a href="#!/operations#UndeployAPI#undeployApiPost">Uneploy the API in the gateway</a></li>
                            </ul>
                        </li>
            </ul>
            <h3>Definitions</h3>
            <ul class="nav nav-stacked fixed">
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-APIArtifact"><a href="#!/models#APIArtifact">APIArtifact</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-DeployResponse"><a href="#!/models#DeployResponse">DeployResponse</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-Endpoints"><a href="#!/models#Endpoints">Endpoints</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-Error"><a href="#!/models#Error">Error</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-ErrorListItem"><a href="#!/models#ErrorListItem">ErrorListItem</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-LocalEntry"><a href="#!/models#LocalEntry">LocalEntry</a></li>
                            </ul>
                        </li>
                        <li class="section-box">
                            <ul class="nav nav-stacked">
                                <li id="def-Sequences"><a href="#!/models#Sequences">Sequences</a></li>
                            </ul>
                        </li>
            </ul>
        </nav>
    </div>
    <!-- /#sidebar-wrapper -->

    <!-- Page Content -->
    <div id="page-content-wrapper">
        <div class="container-fluid main-content">
            <div class="row" class="">
                <div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
                    <div class="non-sidebar">
                        <div class="main-content">
                            <h2>Introduction</h2>

                            <p class="marked">This document specifies a **RESTful API** for WSO2 **API Manager** - Gateway.
Please see [full swagger definition](https://raw.githubusercontent.com/wso2/carbon-apimgt/v6.5.176/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin/src/main/resources/admin-api.yaml) of the API which is written using [swagger 2.0](http://swagger.io/) specification.
</p>

                            <div class="sect2">
                                    <h3>Version information</h3>

                                    <div class="paragraph">
                                        <p class="marked">v1</p>
                                    </div>

                                        <h3>Contact information</h3>

                                        <div class="paragraph">
                                            <p class="marked">Contact: <a href="http://wso2.com/products/api-manager/">WSO2</a></p>

                                            <p>Email: architecture@wso2.com</p>
                                        </div>

                                        <h3>License information</h3>

                                        <div class="paragraph">
                                            <p class="marked">License: Apache 2.0</p>

                                            <p class="marked">URL: http://www.apache.org/licenses/LICENSE-2.0.html</p>
                                        </div>

                                    <h3>URI Scheme</h3>

                                    <div class="paragraph">
                                        <p class="marked">Host: apis.wso2.com</p>

                                        <p class="marked">BasePath: /api/am/gateway/v1</p>
                                        <code>Scheme: [HTTPS]</code>
                                    </div>
                                    <h3>Consumes</h3>

                                    <div class="paragraph">
                                        <code>[application/json]</code>
                                    </div>
                                    <h3>Produces</h3>

                                    <div class="paragraph">
                                        <code>[application/json]</code>
                                    </div>
                            </div>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <!-- /#page-content-wrapper -->

    </div>
</div>
<!-- /#wrapper -->
</body>

</html>
